Inside Macintosh: QuickDraw GX Printing /

Chapter 2 - Core Printing Features / Core Printing Features Reference

Functions / Creating and Managing Job Objects

GXFlattenJob

You can use the GXFlattenJob function when you want to call a function to flatten a job object.

void GXFlattenJob (gxJob aJob, 
                     gxPrintingFlattenProc aPrintingFlattenProc, 
                     void *aVoid);

aJob

A reference to the job object to be flattened.

aPrintingFlattenProc

A pointer to a flattening function.

aVoid

A reference variable passed to the flattening function.

DESCRIPTION

The GXFlattenJob function provides your application with a mechanism for saving all information associated with a job object by specifying a pointer to a flattening function. QuickDraw GX calls your flattening function multiple times as it saves job object-related data to disk.

You specify a pointer to a flattening function in the aPrintingFlattenProc parameter of the GXFlattenJob function.You may prefer to use the GXFlattenJob function (instead of the GXFlattenJobToHdl function) because it requires less memory to save portions of job object data to disk than it does to save all the data in a single handle.

When a user opens a printable document, you need to unflatten all information associated with a job object using the GXUnflattenJob function.

RESULT CODES

gxSegmentLoadFailedErr

A required code segment could not be found, or there was not enough memory to load it.

SEE ALSO

Listing 2-8 on page 2-28 shows how to use the GXFlattenJob function to save a job object.

An example of a flattening function is described on page 2-76.

To unflatten all information flattened using GXFlattenJob, see the GXUnflattenJob function, which is described on page 2-59.

To flatten a job to a handle, see the GXFlattenJobToHdl function, which is described on page 2-56.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help